<!DOCTYPE html>
<html lang="en"><head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1"><!-- Begin Jekyll SEO tag v2.8.0 -->
<title>0097: The HeaderBar | gtkDcoding</title>
<meta name="generator" content="Jekyll v4.3.4" />
<meta property="og:title" content="0097: The HeaderBar" />
<meta name="author" content="Ron Tarrant" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="This GTK Tutorial covers the HeaderBar, a substitute for the Titlebar." />
<meta property="og:description" content="This GTK Tutorial covers the HeaderBar, a substitute for the Titlebar." />
<link rel="canonical" href="http://localhost:4000/posts/0097-headerbar.html" />
<meta property="og:url" content="http://localhost:4000/posts/0097-headerbar.html" />
<meta property="og:site_name" content="gtkDcoding" />
<meta property="og:type" content="article" />
<meta property="article:published_time" content="2020-01-07T00:00:00-05:00" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="0097: The HeaderBar" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"BlogPosting","author":{"@type":"Person","name":"Ron Tarrant"},"dateModified":"2020-01-07T00:00:00-05:00","datePublished":"2020-01-07T00:00:00-05:00","description":"This GTK Tutorial covers the HeaderBar, a substitute for the Titlebar.","headline":"0097: The HeaderBar","mainEntityOfPage":{"@type":"WebPage","@id":"http://localhost:4000/posts/0097-headerbar.html"},"url":"http://localhost:4000/posts/0097-headerbar.html"}</script>
<!-- End Jekyll SEO tag -->
<link rel="stylesheet" href="../assets/main.css">
  <link rel="stylesheet" href="../css/style.css" /><link type="application/atom+xml" rel="alternate" href="http://localhost:4000/feed.xml" title="gtkDcoding" /></head>
<body><header class="site-header" role="banner">

  <div class="wrapper"><a class="site-title" rel="author" href="../">gtkDcoding</a><nav class="site-nav">
        <input type="checkbox" id="nav-trigger" class="nav-trigger" />
        <label for="nav-trigger">
          <span class="menu-icon">
            <svg viewBox="0 0 18 15" width="18px" height="15px">
              <path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
            </svg>
          </span>
        </label>

        <div class="trigger"><a class="page-link" href="../about.html">About</a><a class="page-link" href="../index-reverse.html">Posts in Date Order</a><a class="page-link" href="../topics.html">Blog Posts by Topic</a></div>
      </nav></div>
</header>
<main class="page-content" aria-label="Content">
      <div class="wrapper">
        <article class="post h-entry" itemscope itemtype="http://schema.org/BlogPosting">
	<header class="post-header">
		<link rel="stylesheet" href="../css/font_size.css" />
		<link rel="stylesheet" href="../css/figure.css" />
		<link rel="stylesheet" href="../css/topics/bar.css" />  <!-- sub in the tag/topic -->
		<link rel="stylesheet" href="../css/modal.css" />
		<link rel="stylesheet" href="../css/post.css" />
		<link rel="stylesheet" href="../css/mascot_effects.css" />

		
		
		<p class="post-meta">
		<time class="dt-published" datetime="2020-01-07T00:00:00-05:00" itemprop="datePublished">Tuesday, January 7, 2020
		</time>• by <span itemprop="author" itemscope itemtype="http://schema.org/Person"><span class="p-author h-card" itemprop="name">Ron Tarrant</span></span></p>
	</header>

	<div class="post-content e-content" itemprop="articleBody">
		<div class="skew-line"></div>
		<h1 id="0097-the-headerbar">0097: The HeaderBar</h1>

<p>Sometimes, a plain-jane <code class="language-plaintext highlighter-rouge">Titlebar</code> isn’t flexible enough and so we turn to the <code class="language-plaintext highlighter-rouge">HeaderBar</code>. This <code class="language-plaintext highlighter-rouge">Widget</code> allows:</p>

<ul>
  <li>reordering (or omission) of the standard minimize, maximize, and close buttons,</li>
  <li>adding a sub-title below the title, and</li>
  <li>extra widgets before or after the title and sub-title.</li>
</ul>

<p>It’s also got rounded corners that would go nicely with <a href="./0079-notebook-iii-custom-tabs-i.html">the round-shouldered <code class="language-plaintext highlighter-rouge">Notebook</code> tabs</a> we played with a while ago.</p>

<p>Let’s start with the simplest incarnation and build from there…</p>

<h2 id="a-simple-headerbar">A Simple HeaderBar</h2>

<!-- 0, 1 -->
<!-- first occurrence of application and terminal screen shots on a single page -->
<div class="screenshot-frame">
	<div class="frame-header">
		Results of this example:
	</div>
	<div class="frame-screenshot">
		<figure>
			<img id="img0" src="../images/screenshots/001_window/window_14.png" alt="Current example output" />		<!-- img# -->
			
			<!-- Modal for screenshot -->
			<div id="modal0" class="modal">																	<!-- modal# -->
				<span class="close0">&times;</span>															<!-- close# -->
				<img class="modal-content" id="img00" />															<!-- img## -->
				<div id="caption"></div>
			</div>
			
			<script>
			// Get the modal
			var modal = document.getElementById("modal0");														// modal#
			
			// Get the image and insert it inside the modal - use its "alt" text as a caption
			var img = document.getElementById("img0");															// img#
			var modalImg = document.getElementById("img00");													// img##
			var captionText = document.getElementById("caption");

			img.onclick = function()
			{
			  modal.style.display = "block";
			  modalImg.src = this.src;
			  captionText.innerHTML = this.alt;
			}
			
			// Get the <span> element that closes the modal
			var span = document.getElementsByClassName("close0")[0];											// close#
			
			// When the user clicks on <span> (x), close the modal
			span.onclick = function()
			{ 
				modal.style.display = "none";
			}
			</script>
			<figcaption>
			Current example output
			</figcaption>
		</figure>
	</div>

	<div class="frame-terminal">
		<figure class="right">
			<img id="img1" src="../images/screenshots/001_window/window_14_term.png" alt="Current example terminal output" />		<!-- img#, filename -->

			<!-- Modal for terminal shot -->
			<div id="modal1" class="modal">																				<!-- modal# -->
				<span class="close1">&times;</span>																		<!-- close# -->
				<img class="modal-content" id="img11" />																		<!-- img## -->
				<div id="caption"></div>
			</div>
			
			<script>
			// Get the modal
			var modal = document.getElementById("modal1");																	// modal#
			
			// Get the image and insert it inside the modal - use its "alt" text as a caption
			var img = document.getElementById("img1");																		// img#
			var modalImg = document.getElementById("img11");																// img##
			var captionText = document.getElementById("caption");

			img.onclick = function()
			{
			  modal.style.display = "block";
			  modalImg.src = this.src;
			  captionText.innerHTML = this.alt;
			}
			
			// Get the <span> element that closes the modal
			var span = document.getElementsByClassName("close1")[0];														// close#
			
			// When the user clicks on <span> (x), close the modal
			span.onclick = function()
			{ 
				modal.style.display = "none";
			}
			</script>

			<figcaption>
				Current example terminal output (click for enlarged view)
			</figcaption>
		</figure>
	</div>

	<div class="frame-footer">																								<!-- ------------- filename (below) --------- -->
		The code file for this example is available <a href="https://github.com/rontarrant/gtkd_demos/blob/master/001_window/window_14_headerbar.d" target="_blank">here</a>.
	</div>
</div>
<!-- end of snippet for first (1st) occurrence of application and terminal screen shots on a single page -->

<p>We’ll need a new import statement:</p>

<div class="language-d highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">import</span> <span class="n">gtk</span><span class="p">.</span><span class="n">HeaderBar</span><span class="p">;</span>
</code></pre></div></div>

<p><em>Note: When using the <code class="language-plaintext highlighter-rouge">HeaderBar</code> widget, be sure to make the ‘B’ in ‘bar’ uppercase. This is unlike other</em> GTK <em>entities like <code class="language-plaintext highlighter-rouge">Titlebar</code>, <code class="language-plaintext highlighter-rouge">Toolbar</code>, <code class="language-plaintext highlighter-rouge">Scrollbar</code>, and <code class="language-plaintext highlighter-rouge">Sidebar</code>.</em></p>

<p>For this level of simplicity, we won’t bother deriving our own class/object from the <code class="language-plaintext highlighter-rouge">HeaderBar</code> class, we’ll just toss it into the <code class="language-plaintext highlighter-rouge">TestRigWindow</code> and as you may expect, we’ll do some declarations in the preamble:</p>

<div class="language-d highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">string</span> <span class="n">title</span> <span class="p">=</span> <span class="s">"HeaderBar Basics"</span><span class="p">;</span>
<span class="n">HeaderBar</span> <span class="n">headerBar</span><span class="p">;</span>
</code></pre></div></div>

<p>Nothing we haven’t seen before, so let’s look at how the <code class="language-plaintext highlighter-rouge">HeaderBar</code> gets attached to a window, which we’ll do in the constructor:</p>

<div class="language-d highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">headerBar</span> <span class="p">=</span> <span class="k">new</span> <span class="n">HeaderBar</span><span class="p">();</span>
<span class="n">setTitlebar</span><span class="p">(</span><span class="n">headerBar</span><span class="p">);</span>
</code></pre></div></div>

<p>Just instantiate it and tack it on with <code class="language-plaintext highlighter-rouge">setTitlebar()</code>. And that’s about as simple as we get with a <code class="language-plaintext highlighter-rouge">HeaderBar</code>.</p>

<p>One other thing you’ll notice if you compile and run this demo is that there’s no obvious way to close the <code class="language-plaintext highlighter-rouge">Window</code>. You’ll have to either kill it from the terminal (assuming you ran it from a terminal) with <strong>Ctrl-C</strong> or go through the <em>Task Manager</em> on <em>Windows</em> or, if you’re on <em>Linux</em>, the <em>Gnome System Monitor</em>. Or, also for <em>Linux</em> or whatever other <em>UNIX</em>-alike OS you may be running, <em>top</em> or <em>htop</em> will help you track down and kill the process.</p>

<p>Now let’s look at some of this flexibility we were talking about…</p>

<h2 id="a-decorated-headerbar">A Decorated HeaderBar</h2>

<!-- 2, 3 -->
<!-- second occurrence of application and terminal screen shots on a single page -->
<div class="screenshot-frame">
	<div class="frame-header">
		Results of this example:
	</div>
	<div class="frame-screenshot">
		<figure>
			<img id="img2" src="../images/screenshots/001_window/window_15.png" alt="Current example output" />		<!-- img# -->
			
			<!-- Modal for screenshot -->
			<div id="modal2" class="modal">																<!-- modal# -->
				<span class="close2">&times;</span>														<!-- close# -->
				<img class="modal-content" id="img22" />														<!-- img## -->
				<div id="caption"></div>
			</div>
			
			<script>
			// Get the modal
			var modal = document.getElementById("modal2");													// modal#
			
			// Get the image and insert it inside the modal - use its "alt" text as a caption
			var img = document.getElementById("img2");														// img#
			var modalImg = document.getElementById("img22");												// img##
			var captionText = document.getElementById("caption");

			img.onclick = function()
			{
			  modal.style.display = "block";
			  modalImg.src = this.src;
			  captionText.innerHTML = this.alt;
			}
			
			// Get the <span> element that closes the modal
			var span = document.getElementsByClassName("close2")[0];										// close#
			
			// When the user clicks on <span> (x), close the modal
			span.onclick = function()
			{ 
				modal.style.display = "none";
			}
			</script>
			<figcaption>
			Current example output
			</figcaption>
		</figure>
	</div>

	<div class="frame-terminal">
		<figure class="right">
			<img id="img3" src="../images/screenshots/001_window/window_15_term.png" alt="Current example terminal output" /> 		<!-- img#, filename -->

			<!-- Modal for terminal shot -->
			<div id="modal3" class="modal">																			<!-- modal# -->
				<span class="close3">&times;</span>																	<!-- close# -->
				<img class="modal-content" id="img33" />																	<!-- img## -->
				<div id="caption"></div>
			</div>
			
			<script>
			// Get the modal
			var modal = document.getElementById("modal3");																// modal#
			
			// Get the image and insert it inside the modal - use its "alt" text as a caption
			var img = document.getElementById("img3");																	// img#
			var modalImg = document.getElementById("img33");															// img##
			var captionText = document.getElementById("caption");

			img.onclick = function()
			{
			  modal.style.display = "block";
			  modalImg.src = this.src;
			  captionText.innerHTML = this.alt;
			}
			
			// Get the <span> element that closes the modal
			var span = document.getElementsByClassName("close3")[0];													// close#
			
			// When the user clicks on <span> (x), close the modal
			span.onclick = function()
			{ 
				modal.style.display = "none";
			}
			</script>

			<figcaption>
				Current example terminal output (click for enlarged view)
			</figcaption>
		</figure>
	</div>

	<div class="frame-footer">																							<!--------- filename (below) ------------>
		The code file for this example is available <a href="https://github.com/rontarrant/gtkd_demos/blob/master/001_window/window_15_headerbar_decorated.d" target="_blank">here</a>.
	</div>
</div>
<!-- end of snippet for second (2nd) occurrence of application and terminal screen shots on a single page -->

<p>This time, we’ll go the whole nine yards and derive our own version of the <code class="language-plaintext highlighter-rouge">HeaderBar</code> and it’ll look something like this:</p>

<div class="language-d highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="n">MyHeaderBar</span> <span class="p">:</span> <span class="n">HeaderBar</span>
<span class="p">{</span>
	<span class="kt">bool</span> <span class="n">decorationsOn</span> <span class="p">=</span> <span class="kc">true</span><span class="p">;</span>
	<span class="nb">string</span> <span class="n">title</span> <span class="p">=</span> <span class="s">"HeaderBar Demo"</span><span class="p">;</span>
	<span class="nb">string</span> <span class="n">subtitle</span> <span class="p">=</span> <span class="s">"complete with a full array of titlebar buttons"</span><span class="p">;</span>
	
	<span class="k">this</span><span class="p">()</span>
	<span class="p">{</span>
		<span class="k">super</span><span class="p">();</span>
		<span class="n">setShowCloseButton</span><span class="p">(</span><span class="n">decorationsOn</span><span class="p">);</span> <span class="c1">// turns on all buttons: close, max, min</span>
		<span class="n">setTitle</span><span class="p">(</span><span class="n">title</span><span class="p">);</span>
		<span class="n">setSubtitle</span><span class="p">(</span><span class="n">subtitle</span><span class="p">);</span>
		
	<span class="p">}</span> <span class="c1">// this()</span>
	
<span class="p">}</span> <span class="c1">// class MyHeaderBar</span>
</code></pre></div></div>

<p>Notice in the preamble, we’ve got a <code class="language-plaintext highlighter-rouge">decorationsOn</code> flag and a subtitle string. And when you look at the constructor, you’ll notice a call to <code class="language-plaintext highlighter-rouge">setShowCloseButton()</code>. From the name of this function, you might think there are corresponding functions for showing the minimize and maximize buttons, but that’s not the case. This one function, <code class="language-plaintext highlighter-rouge">setShowCloseButton()</code>, turns them all on.</p>

<p>And a little further down in the constructor, you’ll see how simple it is to stick a subtitle in there with <code class="language-plaintext highlighter-rouge">setSubtitle()</code>.</p>

<p>Now let’s look at one more thing, how to take control of the layout within the <code class="language-plaintext highlighter-rouge">HeaderBar</code>…</p>

<h2 id="headerbar-layout">HeaderBar Layout</h2>

<!-- 4, 5 -->
<!-- third occurrence of application and terminal screen shots on a single page -->
<div class="screenshot-frame">
	<div class="frame-header">
		Results of this example:
	</div>
	<div class="frame-screenshot">
		<figure>
			<img id="img4" src="../images/screenshots/001_window/window_16.png" alt="Current example output" />		<!-- img# -->
			
			<!-- Modal for screenshot -->
			<div id="modal4" class="modal">																<!-- modal# -->
				<span class="close4">&times;</span>														<!-- close# -->
				<img class="modal-content" id="img44" />														<!-- img## -->
				<div id="caption"></div>
			</div>
			
			<script>
			// Get the modal
			var modal = document.getElementById("modal4");													// modal#
			
			// Get the image and insert it inside the modal - use its "alt" text as a caption
			var img = document.getElementById("img4");														// img#
			var modalImg = document.getElementById("img44");												// img##
			var captionText = document.getElementById("caption");

			img.onclick = function()
			{
			  modal.style.display = "block";
			  modalImg.src = this.src;
			  captionText.innerHTML = this.alt;
			}
			
			// Get the <span> element that closes the modal
			var span = document.getElementsByClassName("close4")[0];										// close#
			
			// When the user clicks on <span> (x), close the modal
			span.onclick = function()
			{ 
				modal.style.display = "none";
			}
			</script>
			<figcaption>
			Current example output
			</figcaption>
		</figure>
	</div>

	<div class="frame-terminal">
		<figure class="right">
			<img id="img5" src="../images/screenshots/001_window/window_16_term.png" alt="Current example terminal output" /> 		<!-- img#, filename -->

			<!-- Modal for terminal shot -->
			<div id="modal5" class="modal">																			<!-- modal# -->
				<span class="close5">&times;</span>																	<!-- close# -->
				<img class="modal-content" id="img55" />																	<!-- img## -->
				<div id="caption"></div>
			</div>
			
			<script>
			// Get the modal
			var modal = document.getElementById("modal5");																// modal#
			
			// Get the image and insert it inside the modal - use its "alt" text as a caption
			var img = document.getElementById("img5");																	// img#
			var modalImg = document.getElementById("img55");															// img##
			var captionText = document.getElementById("caption");

			img.onclick = function()
			{
			  modal.style.display = "block";
			  modalImg.src = this.src;
			  captionText.innerHTML = this.alt;
			}
			
			// Get the <span> element that closes the modal
			var span = document.getElementsByClassName("close5")[0];													// close#
			
			// When the user clicks on <span> (x), close the modal
			span.onclick = function()
			{ 
				modal.style.display = "none";
			}
			</script>

			<figcaption>
				Current example terminal output (click for enlarged view)
			</figcaption>
		</figure>
	</div>

	<div class="frame-footer">																							<!---------- filename (below) ---------->
		The code file for this example is available <a href="https://github.com/rontarrant/gtkd_demos/blob/master/001_window/window_16_headerbar_layout.d" target="_blank">here</a>.
	</div>
</div>
<!-- end of snippet for third (3rd) occurrence of application and terminal screen shots on a single page -->

<p>Let’s say, for sake of argument, we have reason to go all <em>Mac</em>-like and put the close button on the left. And for similar reasons, we want the <code class="language-plaintext highlighter-rouge">Window</code>’s custom icon on the right. With a <code class="language-plaintext highlighter-rouge">HeaderBar</code>, the order of things is controlled by the <code class="language-plaintext highlighter-rouge">setDecorationLayout()</code> function.</p>

<p>All else being more or less the same as our previous demo, all we have to do is make the call from within the constructor:</p>

<div class="language-d highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">setDecorationLayout</span><span class="p">(</span><span class="s">"close:minimize,maximize,icon"</span><span class="p">);</span>
</code></pre></div></div>

<p>There are some simple rules with this function:</p>

<ol>
  <li>no spaces anywhere,</li>
  <li>anything before the colon appears to the left of the title and subtitle,</li>
  <li>anything after the colon appears to the right of the title and subtitle.</li>
</ol>

<h2 id="conclusion">Conclusion</h2>

<p>Next time, we’ll continue exploring the <code class="language-plaintext highlighter-rouge">HeaderBar</code>, looking at how to toss other widgets into the mix. Until then…</p>

<div class="blog-nav">
	<div style="float: left;">
		<a href="./0096-hardware-iii-keyboard-pointer.html">Previous: Hardware III - Keyboard &amp; Pointer</a>
	</div>
<!--
	<div style="float: right;">
		<a href="./0098-headerbar-more.html">Next: More HeaderBar Stuff</a>
	</div>
-->
</div>
<p>
	<h3></h3>
<div class="inpage-frame">
	<a href="https://github.com/sponsors/rontarrant">
		<BR>
		<BR>
		<B>Is this article useful? Educational? Entertaining, perhaps?</B>
		<BR>
		<figure class="left">
			<img src="../images/favorite_32.png" alt="Sponsorship heart" style="width: 32px; height: 32px;">
		</figure>
		You're free to accept or decline this invitation to become our newest sponsor.
	</a>
</div>
	<h4 class="comment-blurb"><B>Comments? Questions? Observations?</B></h4>
	<p>
		Did we miss a tidbit of information that would make this post even more informative? Let's talk about it in the comments.
	</p>
	<script src="https://utteranc.es/client.js"
		repo="rontarrant"
		issue-term="pathname"
		theme="github-light"
		crossorigin="anonymous"
		async>
	</script>
	<ul>
		<li> come on over to the <a href="https://forum.dlang.org/">D Language Forum</a> and look for one of the <i>gtkDcoding</i> announcement posts, </li>
		<li> drop by <a href="https://forum.gtkd.org/">the <i>GtkD Forum</i></a>,</li>
		<li> follow the link below to email me, or</li>
		<li> go to the	<a href="https://www.facebook.com">gtkDcoding Facebook page.</a></li>
	</ul>
</p>
<p> You can also subscribe <a href="/feed.xml">via RSS</a> so you won't miss anything. Thank you very much for dropping by.</p>
<p>&copy; Copyright 2025 Ron Tarrant </p>
</div>

	<a class="u-url" href="./0097-headerbar.html" hidden></a>
</article>

      </div>
    </main><footer class="site-footer h-card">
  <data class="u-url" href="/"></data>

  <div class="wrapper">

    <h2 class="footer-heading">gtkDcoding</h2>

    <div class="footer-col-wrapper">
      <div class="footer-col footer-col-1">
        <ul class="contact-list">
          <li class="p-name">Ron Tarrant</li><li><a class="u-email" href="mailto:gtkDcoding@gmail.com">gtkDcoding@gmail.com</a></li></ul>
      </div>

      <div class="footer-col footer-col-2"><ul class="social-media-list"><li><a href="https://github.com/rontarrant"><svg class="svg-icon"><use xlink:href="../assets/minima-social-icons.svg#github"></use></svg> <span class="username">rontarrant</span></a></li></ul>
</div>

      <div class="footer-col footer-col-3">
        <p>Simple examples of how to use GtkD to build GUI applications.</p>
      </div>
    </div>

  </div>

</footer>
</body>

</html>
